Interface Network

All Superinterfaces:
IPCObject
All Known Implementing Classes:
NetworkImpl

public interface Network extends IPCObject
Information provided by the PKI file:

    \class Network
    
    \brief Network is the entry point for all device configurations in the network.  It retrieves devices.
    
    \example network()
    
Author:
Auto-generated
  • Method Details

    • getDevice

      Device getDevice(String deviceName)
      Information provided by the PKI file:
      
          \brief Returns the device with the specified device name.
          
          \param deviceName, the device name of the device of interest.
          
          \return Device, the Device object with the specified device name.
          
              
      Parameters:
      deviceName - Takes in a parameter of deviceName
      Returns:
      Device Returns a Device
    • getDeviceAt

      Device getDeviceAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the device at the specified index.
          
          \param index, the index of the device of interest.
          
          \return Device, the Device object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      Device Returns a Device
    • getDeviceCount

      int getDeviceCount()
      Information provided by the PKI file:
      
          \brief Returns the number of devices in the network.
          
          \return int, the number of devices in the network.
          
              
      Returns:
      int Returns a int
    • getLinkCount

      int getLinkCount()
      Returns:
      int Returns a int
    • getLinkAt

      Link getLinkAt(int index)
      Parameters:
      index - Takes in a parameter of index
      Returns:
      Link Returns a Link
    • getTotalDeviceAttributeValue

      double getTotalDeviceAttributeValue(String attributeName)
      Parameters:
      attributeName - Takes in a parameter of attributeName
      Returns:
      double Returns a double